Allow overriding TUTORIALS_REF in generate_reference_results.py#869
Merged
Conversation
Closes precice#844. Adds --build_args to the reference-generation script and workflow inputs; defaults TUTORIALS_REF to from_ref when not specified.
github-project-automation
Bot
moved this to Planned next
in GSoC 2026: System tests improvements
PranjalManhgaye
moved this from Planned next
to Needs review
in GSoC 2026: System tests improvements
MakisH
reviewed
Jul 9, 2026
MakisH
left a comment
MakisH
left a comment
Member
There was a problem hiding this comment.
Already very nice, thanks!
Testing works: https://github.com/precice/tutorials/actions/runs/29015604369
Just one point regarding the GHA workflow inputs.
MakisH
reviewed
Jul 9, 2026
MakisH
left a comment
MakisH
left a comment
Member
There was a problem hiding this comment.
Some tiny updates, and then ready to merge.
MakisH
reviewed
Jul 9, 2026
MakisH
approved these changes
Jul 9, 2026
github-project-automation
Bot
moved this from Needs review
to Done
in GSoC 2026: System tests improvements
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
When adding a new tutorial on a feature branch, generating reference results used to require temporarily editing
reference_versions.yamlto setTUTORIALS_REF, then changing it back. That was easy to forget and messy in PRs.This PR adds a simpler way:
--build_args on generate_reference_results.py(same idea as systemtests.py)build_argsinput on thegenerate-reference-resultsGitHub Actions workflowreference_versions.yaml(default) or workflow branch(TUTORIALS_REF:<from_ref>).build_argsoverrides if set.Local Testing
Local checks: script compiles, --build_args works, override logic tested
Pre-commit/style checks passed on changed files
The quickstart run showed the override applied correctly
Closes Overriding the TUTORIALS_REF used by generate_reference_results.py #844